home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / cel138a.zip / SETUP.DOC < prev    next >
Text File  |  1991-11-19  |  67KB  |  1,473 lines

  1.  
  2.  
  3.                        C e l e r i t y  v1.38
  4.  
  5.                          BBS Setup Utility
  6.  
  7.  
  8.  
  9.   This documentation file covers the basic set up and configuration of
  10. the Celerity BBS package.  The first section covers the configuration
  11. program itself, SETUP.EXE, and describes some of the options that can
  12. be enabled for Celerity.  The second section covers other items of
  13. consideration when setting up a BBS, including multinode operation and
  14. networking.
  15.  
  16.  
  17. Section I: The Setup Program
  18. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  19. The Celerity Setup Utility is the tool used to provide information
  20. about your BBS, set up conferences, establish restrictions on access,
  21. customize many of Celerity's options, and much more.
  22.  
  23. When SETUP is run, you will be presented with a desktop containing a
  24. menu bar with two menus and a window containing about twenty five
  25. buttons.
  26.  
  27. The first menu on the menu bar contains an About display, and an
  28. option to print a Celerity registration form.  The second menu allows
  29. you to bring up the Celerity Setup Topics (that 25-button window),
  30. restore everything to their default values, and to edit and save
  31. editor color combinations.
  32.  
  33.  
  34. Using Setup
  35. ~~~~~~~~~~~
  36. The dialogs in SETUP.EXE mimic those found in most graphical user
  37. interfaces (GUI) in that they use pulldown menus, windows, buttons,
  38. radio buttons, and more.  If you have a mouse, the setup will be much
  39. easier and quicker to use, but you may still use the keyboard.  If you
  40. use the keyboard, use arrow keys or tab/shift-tab to move from field
  41. to field, and return to select a field.
  42.  
  43. Check boxes are boxes which appear as "[ ]".  If you wish to enable
  44. that option, select the box with the mouse or keyboard, and click (or
  45. press space) on it.  The selected box will now appear as "[X]",
  46. meaning that option has been selected.
  47.  
  48. Radio buttons are a series of buttons which appear as "( )".  With
  49. radio buttons, only one option out of the cluster can be selected, and
  50. selecting a new button will disable the others.  The button with your
  51. current configuration choice will appear as "(·)".
  52.  
  53. Data Fields are boxes with an inverse background that allow you to
  54. enter text.  Sometimes text may be longer than what is displayed on
  55. the screen, indicated by a small arrow pointing to the left or right
  56. at the end of the field.  Home, End, Insert, Delete, and arrow keys
  57. all function within text data fields.
  58.  
  59. OK and Cancel buttons also appear at the bottom of each dialog.  Click
  60. on the OK button when you finish making changes in the dialog, or on
  61. the CANCEL button if you with to throw away any changes you've made.
  62.  
  63.  
  64. Color Setup
  65. ~~~~~~~~~~~
  66. Under the second menu, there is an option to change the colors used
  67. within the setup program.  See the description of color boxes in
  68. "Color Setup" below.
  69.  
  70. Celerity Setup Topics
  71. ~~~~~~~~~~~~~~~~~~~~~
  72. The Celerity Setup Topics screen contains twenty three buttons that
  73. bring up additional information/data entry windows, a Save button, and
  74. an Exit button.  You may use arrow keys to select buttons, or
  75. (preferably) use a mouse to point and shoot.  The functions of each
  76. button will be explained below.
  77.  
  78.  
  79.  
  80. System Info
  81. ~~~~~~~~~~~
  82. This data screen has fields requesting general information about your
  83. BBS.
  84.  
  85. Sysop Name:  This should be the name or handle of the sysop this copy
  86. of Celerity is registered to.  If you wish to view the demo, the sysop
  87. name MUST be "Abdul Clamwacker".
  88.  
  89. Full BBS Name:  This is the complete name of your BBS (ie: The Lexicon
  90. of the Cabal).  Consider a limit of thirty characters or so.
  91.  
  92. Short BBS Name:  Enter the name of your BBS again, in a shorter
  93. version if the real name is excessively long (ie: The Lexicon).  If
  94. the name is short and simple, it is fine to enter the same name in
  95. both fields.  The functional limit should be about fifteen chars.
  96.  
  97. Acronym:  This is a three character field that should be used to
  98. identify your BBS in assorted downloadable files (such as a BBS policy
  99. file, master lists, off-line reader data packets, and the like).
  100. Examples include LEX, TPG, LSD for Lexicon, The Proving Grounds, and
  101. Lost Soul's Domain II, respectively.
  102.  
  103. BBS City:  The city where the BBS is located.  This information is
  104. only to satisfy user interest, and does not affect the operation of
  105. the BBS in any way.
  106.  
  107. BBS State:  Like the city above, this information is inert.  The
  108. state, province, or country where the BBS is located should go here.
  109.  
  110. BBS Phone Number:  Enter the number in the format: 714-627-0601 or
  111. +61-554-2321. This information will be used to determine the locality
  112. of potential users for the Local User Lockout (see "New User Options"
  113. below) and for generating statistics.
  114.  
  115. System Two Name:  If you wish to use a second "system" accessible when
  116. a caller first connects, you can enter the name shown on the menu
  117. here.  For more information about additional systems, see the section
  118. on "Login Commands" below.
  119.  
  120. System Three Name:  See "System 2 Name" above.
  121.  
  122.  
  123. System Options
  124. ~~~~~~~~~~~~~~
  125. The System Options menu contains vital information regarding certain
  126. functions, type of BBS you run, type of machine it is running on,
  127. multinode information, and more.
  128.  
  129. System Toggles:  This section contains a set of check boxes relating
  130. to various features and functions.  Placing an X in the box will
  131. enable that option, placing a space in it will disable it.  These
  132. options are as follows:
  133.  
  134.   Allow Doors:  Will your system allow the use of external programs
  135. (doors) such as on-line games?  See the section on "Doors" below.
  136.  
  137.   Remote Door maintenance:  Should sysops/cosysops be able to add
  138. doors remotely? This can allow unscrupulous cosysops to create doors
  139. that can be potentially dangerous to both security and the well being
  140. of your system.
  141.  
  142.   Allow FAT Move:  This toggle will allow Celerity to move files
  143. around on your hard drive by directly reading and writing to the
  144. disk's directory structure.  This results in a much quicker move of
  145. the file when compared with the non-FAT move, which involves copying.
  146. Consider reading/editing/writing about 512 bytes as opposed to
  147. reading/writing over a million bytes (for a 1 meg file).  If you have
  148. a very delicate file system (ie: not standard MS-DOS), use various
  149. device drivers, or networking, you may need to disable this function.
  150.  
  151.   Sysop Auto Login:  With this option set, the sysop's account will
  152. automatically be logged onto the board when F10 is pressed from the
  153. local end.  Otherwise, the sysop will be required to navigate the
  154. login shell and enter his/her user name and password just like
  155. everyone else.
  156.  
  157.   Voice Chat:  Turning this option on will allow Celerity to use a
  158. digitized voice/sound to call the sysop to chat.  A .VOC sound file
  159. from the sound directory will be chosen randomly and played unless a
  160. file with a specific name (USER1.VOC for user #1, USER120.VOC for user
  161. #120, etc.) exists, in which case it will be played.  If the sysop has
  162. a SoundBlaster or compatible card installed, (see SoundBlaster option
  163. below), the program CHAT.EXE will be called.  Otherwise, the file
  164. "NOBLAST.BAT" will execute, which should contain a batch file to play
  165. the sound via the PC speaker or some alternative card.  Note that
  166. REPLAY.EXE is one .VOC-compatible player for a standard PC speaker.
  167.  
  168.   SoundBlaster:  Turn on this switch if your system contains a
  169. SoundBlaster audio card.  See "Voice Chat" above.
  170.  
  171. Supported bps rates:  This is another check box data area that
  172. contains boxes next to most available bps rates, from 38400bps down to
  173. 300. The sysop may place check marks next to those speeds he wishes to
  174. permit access to his system. Note that if a "Speed Lockout" password
  175. is defined (see "System Passwords" below), a user at an unsupported
  176. rate will be given the opportunity to enter this password and log on
  177. despite the restriction.
  178.  
  179. System Type:  This box contains a set of radio buttons to indicate
  180. which type of on-line system you are running.  You may select only one
  181. of the four types, and it must be an option your registration utility
  182. supports.  The various options are as follows:
  183.  
  184.   Celerity BBS:  The standard full-fledged Celerity BBS
  185.   CAE         :  A no-user-record transfer system
  186.   CAE/TAC     :  A transfer-only system with accounts
  187.   Alacrity BBS   :  Another BBS for future development
  188.  
  189. CPU Type:  More radio buttons.  Indicate the type of system that you
  190. have.  If you have a system based on (or emulating) an Intel (or
  191. other) 8088, 8086, or NEC V-20 processor, select 8088. If you have a
  192. 286 machine, indicate 80286. If you use a 386sx, 386sl, 386dx or
  193. compatible, indicate 80386.  If you have an i486sx, i486dx or
  194. compatible, select i486.  If the i586 ever comes into production, it
  195. should operate under the i486 setting.  Note that the system WILL
  196. function under the incorrect processor setting, but Celerity will not
  197. be able to take advantage of more powerful processors.
  198.  
  199. BBS Node:  If you run a multinode system (see the section on
  200. "Multi-Node BBS"), enter the specific node # here.  If you run only a
  201. single node, be sure to enter a 0.
  202.  
  203. Timeout:  You can determine how many minutes Celerity will allow a
  204. user to sit at a prompt without doing anything.  Once this time is
  205. passed, Celerity will hang up on the user to allow someone else to
  206. call.
  207.  
  208.  
  209. Look and Feel
  210. ~~~~~~~~~~~~~
  211. The Look and Feel menu allows you to enable or disable various options
  212. and features.
  213.  
  214. Look & Feel:  This box contains an array of check boxes: Plaque
  215. Header:  Plaque headers are inverse boxes with shadows.  The non-
  216. plaque version is a line with a block border.  Experiment to see which
  217. you prefer.  The headers appear when users enter various sections or
  218. options. Note that you can design a custom header (see "Customizing
  219. Displays").
  220.  
  221.   Oneliners:  This check box allows the oneliner section to be enabled
  222. or disabled.  Oneliners are single-line ads, sayings, comments, or
  223. graffiti displayed randomly at the main menu.
  224.  
  225.   Key Flash:  The Key Flash Monitor will cycle the NumLock,
  226. ScrollLock, and CapsLock keys when the system is in the WFC (Wait for
  227. Call) mode.  This can be used as an indicator that the system is
  228. active when a user is not on-line (and thus the modem lights are
  229. dark). Do not use this if you are under a multitasking system or
  230. sharing a keyboard with multiple computers.
  231.  
  232.   Use Top 5:  This will enable or disable the viewing of the top 5
  233. lists - top 5 posters, top 5 uploaders, top 5 downloaders - for both
  234. monthly and "all time" compilations.  Note that Top 5 statistics will
  235. be generated whether they are displayed or not. See the "Access
  236. Levels" section below for information on how to remove a user from
  237. eligibility for Top 5 status.
  238.  
  239.   Show Usage:  Enabling this option will ask users as they log on
  240. whether they would like to view the system usage chart (see "Celerity
  241. Add Ons" below).
  242.  
  243.   Hidden Input:  This is a single ASCII character which will be
  244. displayed when user input is "hidden", such as when passwords are
  245. being entered.  It can be 8-bit ASCII, entered via Alt-xxx key
  246. combinations.
  247.  
  248.   Welcome Files :  Celerity will choose a random WELCOME.* file to be
  249. shown when a user logs onto the system.  The welcome files (see
  250. "Customizing Displays") should be named WELCOME.1, WELCOME.2,
  251. WELCOME.3..WELCOME.999.  The highest number should be placed in this
  252. field.
  253.  
  254.  
  255. Wait Text:  When Celerity requires the user to wait for an extended
  256. period, it will display this text.
  257.  
  258. Prompt Format:  The format of the prompts in Celerity can be defined
  259. for an extra degree of originality in a system.  The format will
  260. include regular text, prompt codes, and color codes (see the appendix
  261. on "Color Codes" below). Prompt codes include:
  262.         $:  Displays the time the user has left
  263.         @:  Displays the prompt information
  264.         !:  Displays "?/Help"
  265. example: |b- |W@ |b-|Y $ min |b- Would display:  - Main Menu - 5 min -
  266. with Main Menu in bright white, 5 min in Yellow, and the dashes in low
  267. intensity blue.
  268.  
  269. Anonymous:  The user name to appear in messages which are left
  270. anonymously. (eg: "Who Knows?", "Ghost Writer", "Anonymous")
  271.  
  272.  
  273. Serial Port Setup
  274. ~~~~~~~~~~~~~~~~~
  275. It is imperative that this section is set correctly, or Celerity will
  276. not function (or not function completely) with your modem.  It should
  277. be noted that the COM2 handling on some machines is not fully
  278. standard, and thus some people have problems using COM2 with Celerity.
  279.  
  280. COM Port:  This box contains five radio buttons.  The first two
  281. correspond to the IBM standard IRQ, Address, and interrupt values for
  282. COM1 and COM2.  The second two correspond to the industry standard
  283. values (note that true blue machines do NOT use these values) for COM3
  284. and COM4.  The fifth button will allow you to use the Custom COM Port
  285. settings (see below) so that you can set Celerity up to a specific
  286. format.
  287.  
  288. Custom COM Port:  Allows you to specify the IRQ, interrupt, base
  289. address, and COM port to use for Celerity.  Use this if you have a
  290. non-standard setup.
  291.  
  292. Port Delay:  Celerity is extremely quick in processing outgoing text,
  293. and on many machines will go too fast for serial hardware to keep up.
  294. Rather than limit those with fast hardware by imposing a delay for
  295. everyone, we made this user selectable.  If your users complain on
  296. ANSI or Avatar "garbage", increase the port delay.  Most hardware
  297. should have a setting of about 15 or 20.  Note that having a 16550
  298. UART does not affect this speed limitation.
  299.  
  300. 16550 UART:  If you have a high speed serial UART, let Celerity know
  301. you have it!  A 16550AFN UART provides a buffer so that data can be
  302. moved quicker, and is very helpful when running on a system with a lot
  303. of overhead (excessive use of interrupts by some programs, such as
  304. NCACHE, or multitasking).
  305.  
  306. Input Buffer:  Allows you to specify the size of Celerity's internal
  307. input buffer.  Generally 256 or 512 bytes is sufficient.
  308.  
  309. Output Buffer:  Allows you to specify the size of the output buffer.
  310. This would normally be about 1024 bytes, but can be adjusted up or
  311. down as circumstances warrant.
  312.  
  313.  
  314. Modem Setup
  315. ~~~~~~~~~~~
  316. This section allows you to specify information about your modem setup.
  317. There are also two extra buttons on the right, which allow you to
  318. apply modem settings (take the Celerity recommendations for a modem
  319. listed in the list box) or edit the settings.
  320.  
  321. Modem Type:  This is a list box containing a database of modem types
  322. which have been tested with Celerity.  To load the settings for a
  323. particular modem, you must select it in this box then hit the Apply
  324. Modem Settings button.
  325.  
  326. Offhook Local:  This is a check box which will make Celerity take the
  327. phone off the hook when someone logs onto the system locally.  The
  328. value of this is that users will get a busy signal instead of a ring
  329. when they call while a user is on the system locally.
  330.  
  331. Answer on Ring:  This tells Celerity how many rings to wait for before
  332. it answers the line.  If you specify 0, Celerity will read your serial
  333. port directly waiting for a ring, and is the recommended setting.  If
  334. you specify a value other than 1, Celerity will add "ATS0=n", where n
  335. is your specified value.  In this case, Celerity will wait until the
  336. serial port reports the existence of a carrier, requiring the modem to
  337. initiate the answer process.
  338.  
  339. Hangup String:  This is the AT command which should hang up your modem
  340. if the preferred method of dropping the DTR line does not succeed.
  341. Note that a pipe (|) character indicates a carriage return and a tilde
  342. (~) indicates a 1-second delay.
  343.  
  344. Dial Prefix:  The command needed to force the modem to dial should be
  345. entered here.  Generally, it would be "ATDT".  Some phone systems
  346. require adding additional digits.
  347.  
  348. Dial Suffix:  The suffix of the dial command is usually just a
  349. carriage return (|), but some phone systems may require other digits
  350. for full functionality.
  351.  
  352. Apply Settings:  See the "Modem Type" above.
  353.  
  354. Edit Settings:  Pressing this button will bring up another window.
  355. This window will allow you to alter the standard settings for your
  356. selected modem type.
  357.  
  358.   DTE Rate:  Radio buttons specify at what speed data should be sent
  359. to the modem.  Most high speed modems allow a DTE rate of 19200 or
  360. 38400 bps.  A fixed speed modem (normal 2400, 1200, 300) should use
  361. its maximum speed.
  362.  
  363.   Lock DTE:  High speed modems can lock their operating speed at a
  364. higher DTE rate than the connect rate is.  If this check box is NOT
  365. checked, Celerity will begin communicating at the established speed
  366. upon connection (ie: Celerity will talk to the modem at 2400bps if a
  367. 2400bps call is detected).  If your modem will support a locked DTE
  368. rate, it will give better performance than a modem which does not.
  369.  
  370.   Connect Delay:  After the command to answer is given, Celerity will
  371. wait this length of time (in 1/10th seconds) until it attempts to
  372. determine the connection information.  If the modem responds to a
  373. carrier very quickly, this can be short.  If the modem takes a long
  374. time to determine the connection results, such as many v32 modems,
  375. this should be longer.  If you get calls coming in which Celerity
  376. cannot identify, this value should be increased.
  377.  
  378.   Modem String:  This is the actual command string sent to the modem
  379. to prepare for a call.  Under most circumstances, you should use the
  380. recommended string, or some modification of it.  If you have an
  381. unsupported modem, you can custom tailor it here.
  382.  
  383.  
  384. Video Options
  385. ~~~~~~~~~~~~~
  386. The Video Options dialog contains four check boxes for various aspects
  387. affecting the actual video display.
  388.  
  389. Monochrome:  If you are running on a greyscale VGA or monochrome
  390. system, checking this option will emphasize all low intensity
  391. characters on the local end, making text easier to read.
  392.  
  393. 43/50 Lines:  If you have an EGA or VGA display, Celerity can operate
  394. in a high resolution text mode.  EGA will provide an 80x43 display,
  395. and VGA will give you 80x50.
  396.  
  397. CelerityANSI:  This enables the internal ANSI interpreter, which is
  398. about 65% faster than the fastest dos-based driver we could find.  In
  399. addition, use of the CelerityANSI filter will convert all ANSI codes
  400. to Avatar codes for users who select Avatar terminal emulation,
  401. resulting in a considerable on-line speed increase as well.
  402.  
  403. Screen Saver:  This toggle will allow Celerity to blank the screen
  404. while it is waiting for a call.  It is recommended that you turn off
  405. the monitor, however.
  406.  
  407.  
  408. Conference Setup
  409. ~~~~~~~~~~~~~~~~
  410. If you decide to use conferences with your BBS, you can set them up
  411. here.
  412.  
  413. Use Conferences:  This check box tells Celerity if you wish to use
  414. conferences or not.  If you do not check it, Celerity will function as
  415. a system with only a single conference.
  416.  
  417. Message Conferences:  There are five boxes provided to name up to five
  418. message conferences.  If you do not wish to support a certain
  419. conference, simply leave the name blank.
  420.  
  421. Xfer Conferences:  Names for up to five transfer conferences.  These
  422. can be independent from message conference names.
  423.  
  424.  
  425. Transfer Options
  426. ~~~~~~~~~~~~~~~~
  427. These options alter the way your transfer section looks and behaves.
  428. Note that for the Use File Point System, Upload Factor, Point Value,
  429. and Commission options, the transfer policy is explained to users
  430. whenever they enter the transfer section.
  431.  
  432. File Descriptions:  Celerity allows for much more complete information
  433. to be stored regarding an upload than most bulletin board programs in
  434. its class. Users can select which information they wish to view, as
  435. only so much can be displayed on an 80-character screen.  The four
  436. check boxes in this dialog can be used to disable some of these data
  437. fields from use in your BBS, whether users want them or not.  For a
  438. very simple file area, sysops can disable all these toggled fields.
  439. For a detailed and informative file section, all can be enabled.  The
  440. specific functions of each box are as follows:
  441.  
  442.   Picky Descriptions:  Picky descriptions attempt to force an uploader
  443. to actually describe what he or she uploaded in the description field.
  444. Many lazy users will simply repeat the program name, which is
  445. redundant.  Use this check box only if you use both Program Name and
  446. Description fields.
  447.  
  448.   Program Name:  This enables a 20-character field for the name of a
  449. program. If your system has a preponderance of multiple-disk
  450. downloads, this field is very helpful in forming a unified entry for
  451. all disks.
  452.  
  453.   Disk Numbers:  When this box is marked, users will be prompted for
  454. the total number of disks for the program they upload, as well as the
  455. number for the individual disk.  This is useless if you have very few
  456. multiple-disk uploads.
  457.  
  458.   Description:  A 44-character description field for the upload is
  459. enabled and disabled by this box.  It is a statistical fact that
  460. uploads which are well described are more popular than those which are
  461. poorly described.
  462.  
  463. Xfer Toggles:  This dialog contains many options relating to the
  464. functionality of the transfer section.  They include the following:
  465.  
  466.   User Defined Point Values:  User-defined point values allow the
  467. uploading user, in a file point system, to determine to an extent how
  468. valuable a certain file is, and thus how much it costs.  The user can
  469. specify if the file should be free, one point, quarter, half, normal,
  470. or double the standard cost for a file of its size.  Note that for
  471. this option to have any meaning, the "Auto-Validate" and "Use FPS"
  472. toggles must be checked as well.
  473.  
  474.   Use File Point System:  This toggles the use of a file point system
  475. for your transfer section.  If you use a file point system, users must
  476. "pay" for their downloads with transfer credits.  Transfer credits may
  477. be earned by uploading files, having their uploads downloaded by other
  478. users (see "Commission" below), or granted by the sysop.
  479.  
  480.   Auto-Validate Uploads:  If this option is checked, new uploads will
  481. immediately be posted for general download.  If this box is not
  482. checked, the sysop or cosysop must manually validate each file and
  483. determine its point cost (if a file point system is used).
  484.  
  485.   Auto-Comment Uploads:  This box dictates whether Celerity should
  486. execute a batch file called COMMENT.BAT from your BBS directory.  This
  487. COMMENT.BAT file can be used to delete asinine BBS ads from uploaded
  488. archives, place a zip file header on the archive, or even uncompress
  489. an archive and test it for viruses. Celerity will place the file's
  490. pathname in the %1 batch variable and the file's extension in the %2.
  491. Thus, your batch file can determine if the file is .ZIP, .LZH, .ARJ,
  492. or whatever and process it accordingly.
  493.  
  494.   Use Backup Directories:  This option is not currently in use.
  495.  
  496.   Allow User Requests:  When a user attempts to download a file entry
  497. which is not found on your hard drive, they will be told "that file
  498. isn't here".  If you turn this switch on, the user will be asked if he
  499. or she wishes to leave feedback to the sysop requesting the file.
  500.  
  501.   Allow File Passwords:  If you enable this option, users will be
  502. allowed to attach passwords to their uploads.  Other users must then
  503. enter this password before they can download the file.
  504.  
  505. Upload Factor:  If your system uses a file point system, and you wish
  506. to give users download credit for their uploads, you may enter a
  507. multiplier in this box.  The user will be granted (value_of_upload *
  508. Upload_Factor) points.  For example, a user uploads a file which the
  509. BBS determines is worth four points. With an upload factor of 3, the
  510. user is granted twelve points.  An upload factor of 1 provides four
  511. points, and 0 provides nothing.  The value of the upload is determined
  512. by the sysop if the system does not automatically validate uploads, or
  513. by the "Point Value" below if uploads are immediately posted.  Note
  514. that if you enable the "User Defined Point Value" (see above), the
  515. upload restitution is granted before the user chooses the new value.
  516.  
  517. Point Value:  This variable determines the standard number of
  518. kilobytes that 1 point can download in a system using the FPS, rounded
  519. down.  For example, a 118k file would be worth 2 points if the point
  520. value was 50 (118 / 50 rounds down to 2).  The same file would be
  521. worth 1 point if the point value was 1, or 11 points if the point
  522. value was 10.  This value is used to determine the cost if the file is
  523. auto-validated (see above), or used as the default suggestion when a
  524. sysop manually validates the file.
  525.  
  526. Maximum File Point Loan:  Celerity allows users of a certain level
  527. (see the section on "Access Levels" below) to take out a file point
  528. loan, allowing them to download something they do not have enough
  529. points for, in faith that they will repay the loan in the future.
  530. Alas, some users would abuse this feature if there was no limit to the
  531. credit extended, thus the necessity for this option exists.  The
  532. recommended loan limit is 500 divided by the point value (ie: enough
  533. to download about 500k), but any value (including 0 to disable all
  534. file point loans) is acceptable.
  535.  
  536. Commission:  One of the revolutionary concepts introduced by Celerity
  537. is the system of file point commissions.  This system rewards users
  538. who upload quality data and describe their uploads well, and provides
  539. unequal treatment for those who upload junk.  The the commission
  540. system works as follows:  User #A uploads a file and establishes its
  541. value as 22 points.  When user #B downloads the file, user #A is
  542. credited with a commission.  If a dozen users download a popular
  543. program, user #A gets rich in return for his or her effort. If nobody
  544. downloads the program, user #A is not rewarded as much. The commission
  545. value determines what percentage of the file's cost is given to user
  546. #A.  With a 0% commission, user #A gets nothing when his files are
  547. downloaded (and thus must rely on the points granted by the upload
  548. factor above).  With a 50% commission, user #A gets half of the points
  549. successive users spend downloading (with our example, user #A would
  550. get 11 points when #B downloads the file, and 11 points when #C
  551. downloads, etc.).  With a 100% commission, the uploader gets all of
  552. the points spent by users downloading. This high percentage works
  553. particularly well when the upload factor is 0, so the user gets points
  554. only when his uploads are downloaded, and thus people are encouraged
  555. to upload only useful data which other people will want, and users
  556. waste their time when they upload junk.
  557.  
  558. Upload Time:  When a user spends time uploading, some amount of that
  559. time can be given back to the user so he has more time on your system
  560. that day. The upload time box contains a percentage value for this
  561. awarded time.  With an upload time factor of 200%, a user who spends 5
  562. minutes uploading will receive 10 more minutes of on-line time.  A
  563. 100% upload time factor would return 5 minutes, and a 50% factor would
  564. return about 2 and a half minutes.
  565.  
  566. Download Rates:  Sysops do not like slower users spending an
  567. inordinate amount of time downloading from their transfer sections,
  568. but may recognize their value in the message bases.  Celerity allows a
  569. sysop to determine which bps rates may download from the BBS and which
  570. may not.
  571.  
  572.  
  573. Color Setup
  574. ~~~~~~~~~~~
  575. The color setup dialog is a bit different from other menus.  It
  576. contains two scroll boxes, two color boxes, a window with an example,
  577. and the normal OK and CANCEL buttons.  To operate the color selector,
  578. select the general color set in the left box.  The color sets include
  579. "BBS Colors", "Sysop Tools", and "Status Line".  Moving over to the
  580. middle box, you can select which specific color within the set you
  581. wish to edit.  The two boxes to the far right specify the foreground
  582. and background choices for that particular color.
  583.  
  584. BBS Colors:  These are the eight colors for the BBS that new users
  585. will be set up with when they apply.  These colors can be changed to
  586. suit the user's particular tastes.  Note that when you define color
  587. #8, it must have a non-black background.
  588.  
  589. Sysop Tools:  This color is used to determine the color format of the
  590. on-line Sysop Tool kit.
  591.  
  592. Status Line:  This defines the color of the status bar at the bottom
  593. of the sysop's screen.
  594.  
  595.  
  596. Pathnames
  597. ~~~~~~~~~
  598. The pathnames dialog contains information regarding the location of
  599. various data files for Celerity's use.  The default directories are
  600. recommended, but they can be custom tailored, of course.
  601.  
  602. BBS Directory:  This is the main directory where assorted data files
  603. are kept, including user lists, comment batch files, and the majority
  604. of other files. Note that in a multinode system, this directory should
  605. be the same for all nodes.
  606.  
  607. Temporary Directory:  This is a directory for temporary file creation.
  608. It should have no subdirectories, nor should it contain anything you
  609. wish to keep.  This directory should be independent for each node.
  610.  
  611. Node Directory:  The directory where node-specific files are stored.
  612. The main.bat, celerity.*, and setup.* files should be here, and other
  613. files may be created and stored here by Celerity.  On a single node
  614. BBS, this may be the same as the BBS directory.  On a multinode
  615. system, this must be separate for each node.
  616.  
  617. Shared Data Directory:  If you have a multinode BBS, this directory
  618. will be used for multinode chat and line status information.  It is
  619. recommended that this be located in a RAMdisk if you use one.
  620.  
  621. Message Base Directory:  When Celerity creates message storage files,
  622. they will be kept here.  Note that these files can become quite large.
  623.  
  624. Data Directory:  Information regarding your sub-board and transfer
  625. section configuration will be stored here, as well as index files for
  626. the message section.  Directory files (*.DIR) containing the file
  627. records for your transfer section are also stored in this directory.
  628. Moving this to a large RAMdisk can increase the speed of the system
  629. substantially, but be sure to update the files on the hard drive after
  630. each call (see "Running Celerity with a RAMdisk" below).
  631.  
  632. Menu Directory:  The external menu files for Celerity are located in
  633. this directory, as well as other sysop-defined display files (see
  634. "Customizing Displays" below) and information script files.  Note that
  635. there are four extensions for menus: .ANS for ANSI menus, .AVT for
  636. Avatar, .ASC for ASCII (no color / animation), and . (no extension)
  637. for generic 7-bit ASCII.
  638.  
  639. Network Directory:  If you use CelerityNet, HermesNet, or FidoNet,
  640. this directory will be used for various networking files.
  641.  
  642. Door Directory:  Door data files may be stored here.  See the section
  643. on "Doors" below.
  644.  
  645. Sound Directory:  If you use the digitized chat call, place all of
  646. your .VOC files in this directory.
  647.  
  648. New User Upload Directory:  If you use the validation upload (see "New
  649. User Options" below), this directory will be used to store the zip
  650. listing of the user's upload, and also the uploaded file (if you wish
  651. to save the uploads).
  652.  
  653. Text Editor Pathname:  If you wish to use an external text editor,
  654. accessible from the Online Tools or to enter messages in the subs,
  655. enter the full pathname here.  DOS 5.0's EDIT.COM, QEDIT.EXE, VE.EXE,
  656. ED.EXE, and other editors are all appropriate.  Note that if you wish
  657. to use the external editor to write a message for email or subs, then
  658. the path and filename of "<bbs_Directory>\receive" will be passed to
  659. the editor.  You must save your message with this pathname for it to
  660. be found and processed.
  661.  
  662. ANSI Editor Pathname:  If you have a special program to edit ANSI
  663. files, such as menus, you can enter its path here and call it from the
  664. Online Tools. THEDRAWR.EXE and ANSIEDIT.EXE are both common examples.
  665.  
  666.  
  667. Network Options
  668. ~~~~~~~~~~~~~~~
  669. If you wish to use CelerityNet, you must set the general network
  670. information up here.  The network subs must be set up within the BBS
  671. itself.  If you use HermesNet (not currently available) or FidoNet,
  672. those must be set up elsewhere.
  673.  
  674. Net Toggles:  This cluster of check boxes enables CelerityNet, and
  675. determines its mode of operation.
  676.  
  677.   Use CelerityNet:  Turns CelerityNet on or off.
  678.  
  679.   CelerityNet Host:  If you wish your system to be the center of its
  680. own network, turn this option on.  Note that the network must be set
  681. up via the independent NODEMAN.EXE program.  See the file NODEMAN.DOC
  682. for more information on setting up an independent net.
  683.  
  684.   CelerityNet Hub:  This function is not currently in use.
  685.  
  686. Net Features:  This cluster contains information regarding the
  687. CelerityNet features you wish to use on your system.
  688.  
  689.   Messages:  This enables the networked message bases, by far the most
  690. often-used network function.  Note that sub-boards must be set up from
  691. within the program itself (see "Creating/Editing Sub Boards" in
  692. CELERITY.DOC).
  693.  
  694.   Network News:  From time to time, a news bulletin will be issued
  695. across the network.  If this switch is on, the news will be downloaded
  696. and posted for users to view.
  697.  
  698.   The Stork:  If The Stork is enabled, the network will automatically
  699. download the latest version of Celerity ON THE DAY IT IS RELEASED. The
  700. update will be contained within the UPDATE.ZIP file in your network
  701. directory.
  702.  
  703.   All other options are not currently used.
  704.  
  705. Network Node:  When you join a network, you will be assigned a network
  706. node number.  In the international CelerityNet, this number will match
  707. your serial number.  In a local network, this can be any number the
  708. network host wishes.
  709.  
  710. Network Password:  When a net account is created for your system, a
  711. password will be assigned.  Enter it here.
  712.  
  713. Hub #:  This is not currently used.
  714.  
  715. Network Begin:  This is the time (24-hour format) that your system
  716. will begin dialing your CelerityNet host.  Remember that rates are
  717. cheapest from 11pm-8am.
  718.  
  719. Network End:  This is the time the system will stop attempting to
  720. connect. Note that Celerity will redial once every minute during this
  721. period until it connects or the ending time is reached.
  722.  
  723. Hub/Host Phone Number:  This is the phone number to dial to connect to
  724. the net host.  Note that this should include area code but NOT an
  725. extender.  For the international CelerityNet, this would be
  726. "818-282-3784".
  727.  
  728. Extender:  If you need any special dialing codes, such as a "1" to
  729. dial out of your local area code, a "9" to get an outside line, or a
  730. long-distance service, you can enter the required digits here.
  731.  
  732. Network Origin Line:  At the bottom of every post made on your system
  733. and sent across the network, an origin line will be displayed.  You
  734. may decide what you wish to be displayed here.
  735.  
  736.  
  737. Chat Options
  738. ~~~~~~~~~~~~
  739. Various text messages will be displayed regarding the availability of
  740. the sysop to chat and upon initiation and ending of a chatting
  741. session.
  742.  
  743. Sysop Available:  When the user logs on, if the sysop is available to
  744. chat, this message will be displayed.
  745.  
  746. Sysop Not Available:  If the sysop is not available (see "Online
  747. Commands" in CELERITY.DOC), this message will be displayed.
  748.  
  749. Chat Welcome:  When the sysops enters chat (see "Online Commands" in
  750. CELERITY.DOC), this line is displayed.
  751.  
  752. Chat Goodbye:  When the sysop exits chat, this is displayed.
  753.  
  754. Obnoxious Chat:  This check box will make the chat call loud and
  755. obnoxious, ensuring that the sysop hears it.
  756.  
  757.  
  758. Passwords
  759. ~~~~~~~~~
  760. Various access aspects of Celerity are password protected.  If you
  761. wish passwords to be required, define them here.
  762.  
  763. Security Password:  When a user with sysop access logs on, he or she
  764. will be required to enter the security password to access sysop
  765. options.
  766.  
  767. System 1 Password:  If you use a login shell, you can define passwords
  768. a user will be required to enter before accessing the system.  System
  769. 1 password is for the main BBS.
  770.  
  771. System 2 Password:  See System 1 Password above.  For external system
  772. #2. Also see "Second and Third Systems" below.
  773.  
  774. System 3 Password:  See System 1 Password above.  For external system
  775. #3. Also see "Second and Third Systems" below.
  776.  
  777. Emergency Chat:  Users who know the emergency chat password can force
  778. the system to make a cacophony of obnoxious sound, guaranteed to get
  779. your attention if you are within a square mile of the BBS computer.
  780. This command is accessed by typing "/page" at any BBS prompt.
  781.  
  782. New User Password:  If a password is defined in this field, new users
  783. will be required to enter it before applying for access.
  784.  
  785. Low Speed Password:  If you define a password here, a user calling at
  786. an unsupported bps rate can enter it to bypass the low speed
  787. restriction.
  788.  
  789.  
  790. Timed Events
  791. ~~~~~~~~~~~~
  792. Celerity can be configured to perform certain functions at specific
  793. times of the day.  With the exception of the network time (see
  794. "Network Options" above), these times are established here.  To
  795. disable an event, clear out the start and end times.
  796.  
  797. Restricted Hours:  A system may be set up to allow only users of a
  798. certain level on during a period of time.  The "begin" and "end"
  799. fields here allow you to specify the period.  See "Access Levels"
  800. below to determine the access level required to access the system
  801. during this time.
  802.  
  803. Sysop Available:  If you set the sysop availability flag (see "Online
  804. Commands" in CELERITY.DOC) to "By Time", the sysop chat availability
  805. will be determined by the time specified here.
  806.  
  807. Batch Event:  Celerity can have one external batch file executed at a
  808. certain time.  Define that time and batch file name here.  This file
  809. can be used to run door maintenance files and the like.
  810.  
  811. Time to Backup:  At this time, a file called "BACKUP.BAT" will be
  812. executed. This file should be used to make a daily backup of important
  813. information such as user lists, file directories, and possibly message
  814. bases.  Note that this file can copy files to a floppy, to another
  815. hard drive, or even execute a tape backup program.
  816.  
  817.  
  818. Access Levels
  819. ~~~~~~~~~~~~~
  820. A user's access level can determine which BBS functions he or she may
  821. or may not perform.  These functions are determined below.
  822.  
  823. Access BBS:  Users at and above this level will be permitted to log
  824. onto the system.  Uses below this level will get a "You are not yet
  825. validated" message.
  826.  
  827. Sysop Level:  Users of this level and above may access sysop menus.
  828.  
  829. Post Anonymously:  If a sub-board supports anonymous posting, a user
  830. of this level may make a post anonymously.
  831.  
  832. Post Bulletin:  Users below this level cannot post on the sub-boards.
  833.  
  834. Leave Auto-Message:  This level is required for a user to leave an
  835. automessage for future callers to read.
  836.  
  837. Login During Restricted Hours:  This is the access level required for
  838. the restricted hours.  See "Timed Events" above for more details.
  839.  
  840. Show Anonymous:  Users of this level and above may see who really
  841. posted a message anonymously.
  842.  
  843. List Users:  A user with this level can see the userlist from the main
  844. menu. (See "Main Menu Commands" in CELERITY.DOC).
  845.  
  846. List Recent Callers:  A user with this level can show a list of recent
  847. callers.  (See "Main Menu Commands" in CELERITY.DOC).
  848.  
  849. List Xfer Activity:  Users with this level may list recent upload and
  850. download activity.  (See "Main Menu Commands" in CELERITY.DOC).
  851.  
  852. Show System Status:  To see the storage statistics, a user must have
  853. this level.  (See "Main Menu Commands" in CELERITY.DOC).
  854.  
  855. Show System History:  Users who have this level may view the system
  856. history record.  (See "Main Menu Commands" in CELERITY.DOC).
  857.  
  858. Top Ten Exemption:  Users with this level and above will not be
  859. counted in the calculation of the top ten posters, leeches, and
  860. uploaders.
  861.  
  862. File Point Loan:  Users must have this level to take out a loan.
  863.  
  864. User Time Per Day:  This array of fields defines the amount of
  865. time/day users will get on your system, delimited by user level.
  866.  
  867.  
  868. Login Shell Options
  869. ~~~~~~~~~~~~~~~~~~~
  870. When a caller first connects to Celerity, the system can display a
  871. connection header, detect terminal emulation, and then the user may be
  872. presented with a logon shell or command menu, if you choose to use
  873. one.  Many boards use logon shells today.  Usage of a logon shell
  874. allows you to isolate the new user process from the main board itself,
  875. and to protect the system from unwanted callers. A user who enters the
  876. shell will be presented with a menu of choices, which have static
  877. operations but can have their command keywords customized (see "Login
  878. Shell Commands" below).
  879.  
  880. Connect Header:  When the user first connects, they will be presented
  881. with a connection status message (eg: CONNECT 14400/ARQ/HST) unless
  882. there is a message in this field, in which case that message will be
  883. displayed.
  884.  
  885. Terminal Detection:  If you mark this check box, Celerity will attempt
  886. to determine the user's terminal emulation.  It can differentiate
  887. between TTY, VT-100, ANSI, and Avatar.  Note that Celerity cannot
  888. detect Avatar emulation from the Telix program.
  889.  
  890. Login Shell Type:  Celerity supports five separate shell types:
  891.  
  892.   No Shell:  The user will be dropped directly into the BBS (username
  893. prompt).
  894.  
  895.   Menu Shell:  The menu shell gives the configurable command line.
  896. Hitting a '?' provides the user with a list of supported commands. If
  897. you wish to have a custom shell menu, you can make a file called
  898. SHELL.1 in your menu directory that will be displayed when the '?' is
  899. hit.  Be sure that it has all the commands the user may select.  (See
  900. the "Login Commands" section below).
  901.  
  902.   DOS Shell:  The DOS simulator shell will place the caller into a DOS
  903. simulator, where they will run separate "programs" corresponding to
  904. the shell commands.  The shell commands (see "Login Commands" below
  905. for definition) will be converted to DOS filenames in the form of
  906. .EXE, .COM, or .BAT files (ie: if you choose "Login" as the command to
  907. enter the main BBS, the DOS name will be "LOGIN.EXE").  If the user
  908. types DIR, they will be presented with a "directory" listing of the
  909. commands, or else the optional SHELL.2 file from the menu directory.
  910. This shell is tacky, but some sysops like it.
  911.  
  912.   UNIX Shell:  This shell is not currently in use.
  913.  
  914.   Lightbar:  A list of the available options is presented on a
  915. lightbar menu. Users may select which option they wish by typing the
  916. corresponding number, or by selecting the option with the bar and
  917. pressing enter.  The user must have ANSI, VT100, or Avatar emulation
  918. to use this.  If the caller does not have one of these terminal
  919. emulations, he will get the menu shell.
  920.  
  921.   External Shell:  If you are a programmer and wish to write your own
  922. shell routines called EXTERN.EXE, select this option and Celerity will
  923. call it.
  924.  
  925. As the shell is fully configurable, you can make Celerity look like
  926. some other type of system.  Have it mimic a mainframe or mini if you
  927. want to conceal the fact that it is a private bulletin board system.
  928. Using the connect string, the SHELL.1 help screen, and the definable
  929. shell commands, you can make the shell look like anything you like.
  930.  
  931.  
  932. Login Commands
  933. ~~~~~~~~~~~~~~
  934. To make each system's login shell a little more unique, Celerity
  935. allows sysops to define the commands used to perform various shell
  936. functions.  Users will be required to enter these command words in the
  937. Menu, DOS, and UNIX shells.  An option menu will be displayed on the
  938. menu when users type '?', 'dir', or 'ls' for the Menu, DOS, and UNIX
  939. shells respectively unless the SHELL.1, SHELL.2, or SHELL.3 files
  940. exist in the menu directory, in which case they will be displayed
  941. instead.  Note that the lightbar shell does not require users to enter
  942. keywords.  To disable an option, simply clear its respective command
  943. field, and that option will not be offered to the user
  944.  
  945. Login Shell Commands:  There are three login shell commands, one for
  946. each virtual system.  The first is for your main BBS, while #2 and #3
  947. are for external BBS programs (see "Second and Third Systems" below).
  948.  
  949. Apply For Access:  This command is what a new user must enter to apply
  950. for access to the main system.  A user must give a new user pass if it
  951. is required (see "System Passwords" above), and fill out any
  952. information forms the sysop has defined.  See "The New User Process"
  953. in CELERITY.DOC for more.
  954.  
  955. Check:  This command allows a new user to check on the status of his
  956. or her application in the main system.  If the user has been
  957. validated, he or she will be given the password to system 1, and be
  958. allowed to enter.  If the new user voting system is enabled, the user
  959. will be informed as to the up-to-the-minute results of the voting.
  960.  
  961. Feedback:  This option allows users to leave feedback to the sysop
  962. from the shell.
  963.  
  964. Chat:  If a user enters this keyword, the sysop will be paged for a
  965. chat.
  966.  
  967. Log Off:  This command will log the user off the system, hanging up
  968. the modem and returning to the Wait for Call screen or DOS.
  969.  
  970. Command Prompt:  The prompt line for the logon shell (for the Menu
  971. shell only) may be defined to add an additional flair of originality
  972. to the BBS. Common prompt lines include "[Command/?]" and "Login:".
  973.  
  974.  
  975. Information Scripts
  976. ~~~~~~~~~~~~~~~~~~~
  977. Also called Scripts, Info-Forms, and Questionnaires, Information
  978. scripts are forms a sysop can design to have users provide information
  979. about themselves. This setup dialog contains information regarding
  980. five separate information scripts, and asks for the following
  981. information from each:
  982.  
  983. Information Script Name: The title or brief description of the form's
  984. use.
  985.  
  986. Force:  If this check box is marked, users will be required to fill
  987. out this script.  If it is not checked, then users may decide for
  988. themselves whether they wish to fill out the script.
  989.  
  990. Minimum Level:  Users below this access level will not be permitted to
  991. fill out the information script.  Note that new users usually have an
  992. initial level of 0.
  993.  
  994. Maximum Level:  Similar to the minimum level, users over this level
  995. may not access the information script.
  996.  
  997.  
  998. Two disk files in your menu directory are associated with each script,
  999. where 'x' is a number from 1 to 5 referring to the corresponding
  1000. script:
  1001.  
  1002. INFOTEXT.x:  A text message explaining how to fill out the script
  1003. INFOFORM.x:  The text of the script itself
  1004.  
  1005. Infomation Script #5 is unique.  New users can have their script #5
  1006. viewed by other users if you use a new user voting system, so don't
  1007. ask classified data here.  Make sure that you indicate to users
  1008. filling out information script #5, through the infotext.5 file or on
  1009. the form itself, that information here can be viewed by other users.
  1010.  
  1011. To make an information script, create a text file.  Place all of your
  1012. questions in the file, and an asterisk (*) wherever you want to user
  1013. to respond with data.  If you wish to use an ANSI full screen
  1014. infoform, use your ANSI editor, such as TheDraw, to draw the form and
  1015. everything you want on it, but do NOT put any asterisks on yet.  When
  1016. you have the form looking exactly how you would like it, go into
  1017. animation mode and place asterisks where you would like data to
  1018. appear.
  1019.  
  1020. Infomation scripts can be used to capture a wide range of information
  1021. about a user, but they don't have to be mandatory.  You may have some
  1022. special service on your BBS which users may apply for, but are not
  1023. forced to.  Making a non-mandatory form can be quite helpful in cases
  1024. such as this one.
  1025.  
  1026. Suggestions for infoforms include:  Sysop Information (personal
  1027. information about the user), New User Application (form #5 for the new
  1028. user voting panel to examine), Private Access (have users answer this
  1029. before gaining access to a private section), Group Application (if
  1030. your board is affiliated with a group or organization, users may
  1031. request to join), Visiting Sysop (if the user runs a board).
  1032.  
  1033.  
  1034. New User Options
  1035. ~~~~~~~~~~~~~~~~
  1036. The following options all relate to how new users are handled by your
  1037. system.  New users will also normally be asked to fill out information
  1038. scripts  (see above), and on some systems will be subjected to the New
  1039. User Voting section (see "New User Voting" below).  Other functions
  1040. related to the new user process include the new user password (see
  1041. "Passwords" above), Local User Lockout (see "Local Users" below), and
  1042. Quick Validate (see "Quick Validate" below).
  1043.  
  1044. New User Toggles:  This cluster contains check boxes to enable or
  1045. disable various features of the new user section.
  1046.  
  1047.   Refuse New Users:  If this box is marked, someone who applies as a
  1048. new user will have the PRIVATE.BBS file (from the menu directory)
  1049. displayed, and will not be permitted to apply.
  1050.  
  1051.   Hang Up:  Checking this box will make Celerity hang up on new users
  1052. after they finish their application.
  1053.  
  1054.   Require Validation Upload:  Checking this box will enable a unique
  1055. Celerity feature: the validation upload.  New users who call will be
  1056. asked to upload a new file for examination by the sysop and new user
  1057. voting panel.  The text the user is presented with may be tailored to
  1058. your system by creating a file called VALIDUD.BBS in your menu
  1059. directory.  Note that the upload must be in the ZIP format.
  1060.  
  1061.   Save Validation Upload:  If the sysop wishes to keep the uploaded
  1062. file, he must check this box.  If this box is not checked, only a
  1063. record of the upload (a zip listing) will be saved.  These files will
  1064. be stored in the new user upload directory (see "Pathnames" above).
  1065.  
  1066.   Require Feedback:  If this box is checked, new users will be asked
  1067. to leave a letter requesting access to the system staff.
  1068.  
  1069.   Use Address:  Checking this box will ask new users for their
  1070. address.
  1071.  
  1072. New User Note:  Every user has a special user note which can tell the
  1073. name of his or her bbs, an organization he or she belongs to, or a
  1074. comment about the user's access level.  For new users, you can
  1075. determine the default note that they will be given here.
  1076.  
  1077. New User Access Level:  New users will be granted this access level.
  1078. Note that if this level is under the level required to access the BBS
  1079. (see "Access Levels" above), the user will not be permitted to access
  1080. the system until validated.
  1081.  
  1082. New User Xfer Level:  This is the initial level given to new users.
  1083.  
  1084. New User Xfer Points:  If you use a file point system, this field can
  1085. be used to give new users a few points to get started with.
  1086.  
  1087.  
  1088. New User Voting
  1089. ~~~~~~~~~~~~~~~
  1090. The purpose of the New User Voting (abbreviated NUV) system is to
  1091. allow the users of a system have a say in who gets access and who
  1092. doesn't to the system. There are five data options in the setup
  1093. relating to the New User Voting.
  1094.  
  1095. Enable New User Voting:  This turns the section on and off.  If it is
  1096. off, no other NUV options will be used.
  1097.  
  1098. Automatically Validate and Delete:  If this check box is marked, a new
  1099. user will be validated or deleted when they gain the required number
  1100. of votes for either category.  If this is turned off, a user with NUV
  1101. sysop access must manually process those pending validation or denial.
  1102.  
  1103. Yes Votes:  This is the number of yea votes a new user will be
  1104. required to get before being validated.
  1105.  
  1106. No Votes:  This is the number of nay votes a user can garner before
  1107. being denied access to the system.
  1108.  
  1109. Level to Access NUV:  Users must have this level to enter the new user
  1110. voting section from the main menu.
  1111.  
  1112. Level to Force NUV:  If a user has this level, he or she will
  1113. automatically be dropped into the NUV system when they log onto the
  1114. system if there are new users to vote on.  This is a handy way of
  1115. making your elite users do something with their access.
  1116.  
  1117. The process works like this.  When a new user logs on, they will enter
  1118. all their normal information, plus Information Script #5 (see
  1119. "Information Scripts" above), which is reserved for the New User
  1120. Voting section.  They will be given 0 Yes and 0 No votes, and be
  1121. logged off. When other users call, they may enter the New User Voting
  1122. section and view the existing new users awaiting a decision.  They may
  1123. scan for users they have not voted on, and be given the option to view
  1124. the fifth infoform, and make a judgement (yes, no, or abstain) on the
  1125. new user.  Users may change their vote at any time before the Yea or
  1126. Nay threshold has been reached.  Voting users may enter a 50-character
  1127. comment regarding the user.
  1128.  
  1129. When the new user attempts to log on again, he or she will be given an
  1130. up-to-date status report on how the voting is going.  If enough YES
  1131. votes are cast, the new user will be auto-validated (as per the quick
  1132. validate parameters set by the sysop).  If enough NO votes are cast
  1133. (also definable), the user will be given an access level of -5, which
  1134. will give the user a message saying "Your application has been denied
  1135. by the user voting panel", and deleted when he/she logs on again.  The
  1136. text file "DENIED.BBS" will be displayed to users who have been turned
  1137. down.  If the automated NUV option is turned off, the sysop must
  1138. manually decide on each of the users before any action is taken.
  1139.  
  1140. Some new users will never call back, and in this case, the sysop can
  1141. simply scan for users with -5 access who have not called in a week or
  1142. so and delete them.
  1143.  
  1144.  
  1145. Local Users
  1146. ~~~~~~~~~~~
  1147. To many sysops, local users can be valued members of their system.  To
  1148. others, however, they can be the bane of quality.  The assumption that
  1149. "good users will call long distance to find good boards" is often
  1150. found to be true.  Thus, Celerity offers the Local User Lockout
  1151. (abbreviated as LUL) system to limit the number of locals permitted on
  1152. the system.  A local user is considered by Celerity to be one calling
  1153. from the same area code as that of the BBS.
  1154.  
  1155. Use Local User Lockout:  This simply enables the LUL system.
  1156.  
  1157. Local User Percentage:  This is the percentage of local users allowed
  1158. on the system.  Thus, as the system gets larger, the ratio of locals
  1159. to non-locals remains consistent.  Some boards set this value as low
  1160. as 5 or 10%.  Note that if additional local users are added manually
  1161. by the sysop, or if non-local users are deleted from the system, or if
  1162. this number is lowered, the actual percentage of local users may be
  1163. higher than this value.  Until the percentage falls below this defined
  1164. value, no additional local users will be accepted.
  1165.  
  1166. Lockout Message:  This is a single-line message which will be
  1167. displayed to a user who has been locked out by the LUL.
  1168.  
  1169.  
  1170. User Ratios
  1171. ~~~~~~~~~~~
  1172. User ratios are an effective means of measuring performance by users,
  1173. and can be used with the same degree of fairness for both new users
  1174. and veterans of your system.  Celerity has three different ratios
  1175. which can be used to restrict a user from downloading.  These are
  1176. outlined below.  In each case, there are two values to be set in
  1177. SETUP.  The first is the ratio you wish to require, and the second is
  1178. an access level a user may have to be exempt from that ratio.  Also
  1179. note that the user exemption flags (see "User Access" in CELERITY.DOC)
  1180. which can exempt a user from ratios as well, despite his or her access
  1181. level.
  1182.  
  1183. Post/Call Ratio:  Also known as a PCR, this is a number which
  1184. considers the number of posts a user has made against the number of
  1185. calls made.  If a user has made 75 posts and 100 calls, his ratio
  1186. would be (75 / 100) .75, or 75%.  Although quality users find it easy
  1187. to maintain ratios of 200 or 300%, many users will find the ratio
  1188. excessively binding if it is over 50% (one post per two calls).
  1189.  
  1190. Upload/Download Ratio:  Known as a UDR, this ratio calculates the
  1191. number of uploaded files divided by the number of downloads (a
  1192. separate kbytes uploaded vs kbytes downloaded ratio is also
  1193. maintained).  If the user downloads excessively, this ratio can be
  1194. used to cajole him or her into uploading occasionally to maintain his
  1195. or her ratio.
  1196.  
  1197. General Ratio:  This ratio is a composite of the PCR and UDR.  If you
  1198. choose to make this the main restriction, users can specialize in
  1199. either subs or transfers and not be penalized for it.  Users who have
  1200. an extremely good UDR but don't post often won't find themselves
  1201. restricted , and vice versa.  This can be a happy medium for sysops
  1202. who wish their users to contribute to the subs, but don't want to
  1203. exclude couriers who call only to upload new releases.
  1204.  
  1205.  
  1206. Conference Access
  1207. ~~~~~~~~~~~~~~~~~
  1208. This dialog contains information pertaining to conference access for
  1209. new users and for users who are Quick Validated.  It also has other
  1210. quick-validate information similar to that in the New User Options
  1211. section (see "New User Options" above).  Users may be quick validated
  1212. through the NUV system (see "New User Voting" above), or via the
  1213. quick-validate key from the system's sysop options (see "Sysop Menu
  1214. Commands" in CELERITY.DOC).
  1215.  
  1216. Conference access is divided into four check box clusters: one each of
  1217. message conference access and xfer conference access for users who are
  1218. Quick Validated and those who are not.  Placing check marks in the
  1219. boxes will enable access to that conference.
  1220.  
  1221. Quick Validate User Note:  Users who are quick-validated will be given
  1222. this user note.
  1223.  
  1224. Quick Validate Access Level:  When a user is quick-validated, he will
  1225. be given this access level.
  1226.  
  1227. Quick Validate Xfer Level:  This is the transfer level a
  1228. quick-validated user will be given.
  1229.  
  1230. Quick Validate Transfer Points:  If you wish to give quick-validated
  1231. users a few transfer points to start with, define the amount in this
  1232. field.
  1233.  
  1234.  
  1235. Section II:  Other Configuration
  1236. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1237.  
  1238.  
  1239. Color Codes
  1240. ~~~~~~~~~~~
  1241. Certain text strings, such as oneliners, prompt format, etc. can use
  1242. color codes to add a splash of color.  The codes are always preceded
  1243. by a pipe character (|) and are a single digit.  The codes are as
  1244. follows:
  1245.  
  1246. |1 - User color #1
  1247. |2 - User color #2
  1248. .
  1249. .
  1250. |8 - User color #8
  1251. |9 - Carriage return (for multiple-line prompts, etc.)
  1252. |b - Low intensity blue
  1253. |g - Low intensity green
  1254. |c - Low intensity cyan
  1255. |r - Low intensity red
  1256. |m - Low intensity magenta
  1257. |y - Low intensity yellow (brown)
  1258. |w - Low intensity white
  1259. |d - High intensity black (dark gray)
  1260. |B - High intensity blue
  1261. |G - High intensity green
  1262. |C - High intensity cyan
  1263. |R - High intensity red
  1264. |M - High intensity magenta
  1265. |Y - High intensity yellow (yellow)
  1266. |W - High intensity white
  1267.  
  1268.  
  1269. Customizing Displays
  1270. ~~~~~~~~~~~~~~~~~~~~
  1271. One of the specialties of Celerity is its ability to allow sysops to
  1272. change the way it looks.  A number of display screens and display
  1273. features may be altered or radically changed to suit the sysop's
  1274. desires.
  1275.  
  1276. Some of the factors affecting a user's display are changed above, but
  1277. I will outline them here for your reference.
  1278.  
  1279. Look and Feel section:  This section of Setup is particularly
  1280. effective in changing the look of your system.  Note the "Plaque
  1281. headers" and "Prompt Format" options in particular.
  1282.  
  1283. Color Setup:  This section also has an impact on the appearance of
  1284. your system, particularly the default user colors.  Although users can
  1285. and do change their colors, many people get a first impression from
  1286. the look of the default color set.
  1287.  
  1288. Configurable Status Screens
  1289. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1290. Celerity also allows a sysop to design his or her own status screens
  1291. to replace those available in Celerity by default.  The four screens
  1292. which can be changed include the login status, the user's status
  1293. display, the transfer status, and the sysop's user status screen.  The
  1294. filenames associated with these displays are as follows:
  1295.  
  1296. LOGNSTAT. : Replaces the Login status.
  1297. YOURSTAT. : Replaces the main "Your Status" screen.
  1298. XFERSTAT. : Replaces the Xfer status screen and xfer policy box.
  1299. USERSTAT. : Replaces the status screen in the sysop's user edit section.
  1300.  
  1301. To use a status screen, you must make a file with one of the names
  1302. listed above.  Make sure the files do not have a suffix.  If you wish
  1303. to make different files for different emulations, do so, but you MUST
  1304. have one file with no suffix. You can add .ANS and .ASC files if you
  1305. desire.
  1306.  
  1307. To design a screen, you should have access to TheDraw, ANSIEdit, or
  1308. another ANSI paint/draw screen unless you wish to design text-only
  1309. screens with no color.  When you have the screen drawn (minus the
  1310. data), enter the animation mode (in TheDraw, cursor positioning
  1311. commands in other programs) and place the display commands at the
  1312. location you wish the data to appear.  There are two sets of display
  1313. commands, one preceded by an "@" character, and one preceded by a "`"
  1314. character.  The display commands are as follows.
  1315.            
  1316. @A - Sysop Available / Sysop not available
  1317. @H - User's handle
  1318. @R - User's Real name
  1319. @P - User's phone number
  1320. @N - User note
  1321. @p - Password
  1322. @T - Total time spent online
  1323. @t - Time left today
  1324. @# - Total number of calls
  1325. @1..@5 - displays the conference name IF the user has access to the conf.
  1326. @L - Date of last call
  1327. @l - Time of last call
  1328. @h - Hack attempts
  1329. @S - Sysop availability
  1330. @c - Last caller
  1331. @B - User's BBS level
  1332. @X - User's Xfer level
  1333.  
  1334. `X - Number of uploads
  1335. `x - number of downloads
  1336. `K - K uploaded (includes a 'k' at the end of the value)
  1337. `k - K downloaded (also includes a 'k' at the end)
  1338. `R - Upload/Download ratio (includes a '%' at the end)
  1339. `r - Upload K/Download K ratio (includes '%')
  1340. `F - File points
  1341. `C - Commission points earned  (since last call)
  1342. `V - Validation points earned   (since last call)
  1343. `U - New uploads
  1344. `P - New posts
  1345. `M - Mail waiting
  1346. `c - Average CPS rate user gets downloading
  1347. `p - Number of posts made
  1348. `% - Post/Call ratio
  1349.  
  1350. Some sysops have designed alternate screens which are available on the
  1351. Celerity support BBS.  If you design some and wish to share them, feel
  1352. free to upload them.
  1353.  
  1354. Sysop-definable Display Files
  1355. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1356. Any file in the MENU directory can be modified without severe impact
  1357. on the system.  Sysops are encouraged to tailor the screens to meet
  1358. the needs and motif of their systems.  Some of the files which may be
  1359. altered are listed below:
  1360.  
  1361. DONATION.    : No extension.  This file is displayed when the user
  1362. types the "$" command from the main menu.  Usually contains the BBS'
  1363. donation policy.
  1364.  
  1365. GOODBYE .    : No extension.  This is displayed to all users upon
  1366. logging off the system.  Often contains a list of other BBS' supported
  1367. by your system.
  1368.  
  1369. NEWUSER .    : When new users log on, this file will be displayed.  It
  1370. usually will tell a bit about the system and access requirements.
  1371.  
  1372. NICETRY .    : A message displayed to users who fail to enter their
  1373. password an excessive number of times.  It usually contains a message
  1374. to the effect of "If you were a new user, you aren't wanted here.  If
  1375. you're a hacker, fuck off".  Not that a nasty message will stop a
  1376. hacker.
  1377.  
  1378. RAISEREQ.    : No extension.  If a user requests an access raise via
  1379. the "!" command at the main menu, this file is displayed.  It has a
  1380. special format which must be followed.  At the beginning of the file,
  1381. any number of lines of text can be displayed, and will be shown to all
  1382. users.  Following the initial block of text are additional notes
  1383. depending on the user's current level.  To add additional notes, enter
  1384. a period on a blank line, and on the next line enter the level range
  1385. (ie: 0-9, 10-50, etc.).  The third and following lines contain the
  1386. notes for that level.
  1387.  
  1388. SUMMON  .    : No extension.  This text is displayed to the sysop when
  1389. the chat call is activated.  Something short is sufficient.
  1390.  
  1391. TIMESUP .    : No extension.  This text is displayed to a user if they
  1392. run out of time and are kicked off the system.
  1393.  
  1394.  
  1395. The following files all have .BBS as an extension.  You may include
  1396. *.ASC versions without color, and .TXT files for users without IBM
  1397. ASCII.
  1398.  
  1399. VALIDUD .BBS : Text displayed with the validation upload.
  1400.  
  1401. PRESHELL.BBS : A file which is displayed before the shell is entered.
  1402.  
  1403. CAEINTRO.BBS : Text to be displayed when a caller connects to a CAE.
  1404.  
  1405. OTHERSYS.BBS : A message which is displayed when the user is kicked
  1406. off the normal system (see "Negative Access Levels" in CELERITY.DOC)
  1407. and given the password to system 2 or 3.
  1408.  
  1409. DENIED  .BBS : A message displayed to a user who has been denied
  1410. access in the new user voting section.
  1411.  
  1412. FEEDBACK.BBS : Message a new user gets indicating them to leave
  1413. feedback to the sysop after applying for access.
  1414.  
  1415. PRELOGON.BBS : A "system identification" message displayed before a
  1416. caller enters his or her user name and password.  This is displayed
  1417. after the first system is entered from the shell if a shell is used,
  1418. or immediately if a shell is not used.
  1419.  
  1420. CHANGES .BBS : Quick "news brief" displayed AFTER PRELOGON.BBS, and
  1421. before the user enters his/her handle/password etc.  This should not
  1422. be more than one line, and may be omitted altogether if there is no
  1423. special news (appropriate news would be "Please fill out the first
  1424. infoform.  Skip the rest.".  Inappropriate news would be "Hard disk
  1425. crash.  Userlist lost.  Log on new." Because of Celerity's Auto-backup
  1426. feature (see "Auto-Backup" above), there is NEVER any excuse for
  1427. loosing a userlist.)
  1428.  
  1429. AD      .BBS : Displayed when a user hits "&" from the main menu.  It
  1430. can be an ad for the software, or changed to something more
  1431. appropriate for your system.
  1432.  
  1433. BLACKLST.BBS : Displayed to a user who attempts to apply and has his
  1434. name in the blacklist file.  See "BLACKLST." below.
  1435.  
  1436. PROT_?  .BBS : An ANSI menu of available protocols.  The ? wildcard
  1437. may be S for non-batch downloads, R for non-batch uploads, D for batch
  1438. downloads, and U for batch upload protocols.
  1439.  
  1440. XFERNEWS.*   : This is some transfer news which will be displayed to a
  1441. user who enters the transfer section.  The * wildcard represents the
  1442. conference number.
  1443.  
  1444. Blacklst.    : This file has no extension.  It contains a list of
  1445. handles which you do not want admitted to your system.  If a user is
  1446. listed here, they will be displayed the Blacklst.BBS (see above) file
  1447. when they log on new.
  1448.  
  1449. Welcome.*    : ANSI welcome screens have a suffix of a numerical value
  1450. from one to 9 (you may have 9 ANSI logon screens, displayed at random
  1451. when a user has entered his/her password).  You may have one
  1452. WELCOME.ASC file and one WELCOME.TXT file for non-ANSI users.  Enter
  1453. the number of ANSI screens you have in the setup section to ensure
  1454. proper randomization.
  1455.  
  1456. Custom Menus
  1457. ~~~~~~~~~~~~
  1458. In your menu directory, you will find about thirty different menu
  1459. files, with up to four extensions each.  The different extensions
  1460. represent menus for different terminal emulations, as follows:  ANS
  1461. extensions are for ANSI menus, including color, animation, and
  1462. high-bit ASCII.  ASC extensions are for those who can see IBM ASCII,
  1463. but not color or animation.  AVT extensions represent menus for those
  1464. with Avatar.  Note that these may be the same as ANS menus, and will
  1465. be converted on-the-fly when users view them.  No extension are for
  1466. straight 7-bit ASCII text menus.
  1467.  
  1468.  
  1469.  
  1470. Note that the documentation will be further refined and expanded with
  1471. the next version of Celerity.
  1472.  
  1473.